FHIR IG analytics| Package | hl7.fhir.us.codex-radiation-therapy |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-codexrt-radiotherapy-primary-plan-dose.json |
| FHIR Version | R4 |
| Source | https://build.fhir.org/ig/HL7/codex-radiation-therapy/StructureDefinition-codexrt-radiotherapy-primary-plan-dose.html |
| URL | http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-primary-plan-dose |
| Version | 2.0.0 |
| Status | active |
| Date | 2026-02-11T00:55:08+00:00 |
| Name | PrimaryPlanDose |
| Title | Primary Plan Dose |
| Realm | us |
| Authority | hl7 |
| Description | This flag is true if the dose is the primary plan dose in a radiotherapy treatment plan. For a single treatment plan, the primary plan dose serves as the main dose value for tracking delivered dose vs. planned dose. In summaries over multiple treatment plans, the flag indicates that the dose is a primary plan dose in any of the summarized plans. |
| Type | Extension |
| Kind | complex-type |
| StructureDefinition | ||
| hl7.fhir.us.codex-radiation-therapy#current | codexrt-radiotherapy-course-summary | Radiotherapy Course Summary |
| hl7.fhir.us.codex-radiation-therapy#current | codexrt-radiotherapy-planned-course | Radiotherapy Planned Course |
| hl7.fhir.us.codex-radiation-therapy#current | codexrt-radiotherapy-planned-phase | Radiotherapy Planned Phase |
| hl7.fhir.us.codex-radiation-therapy#current | codexrt-radiotherapy-treated-fraction | Radiotherapy Treated Fraction |
| hl7.fhir.us.codex-radiation-therapy#current | codexrt-radiotherapy-treated-phase | Radiotherapy Treated Phase |
| hl7.fhir.us.codex-radiation-therapy#current | codexrt-radiotherapy-treated-plan | Radiotherapy Treated Plan |
| hl7.fhir.us.codex-radiation-therapy#current | codexrt-radiotherapy-treatment-plan | Radiotherapy Treatment Plan |
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition codexrt-radiotherapy-primary-plan-dose
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Extension | 0..1 | Extension | Primary Plan Dose | |
  extension | 0..0 | Extension | ||
| url | 1..1 | uri | "http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-primary-plan-dose" | |
  value[x] | 0..1 | boolean | Primary Plan Dose | |
| Documentation for this format | ||||
FHIR
FHIRsmith{
"resourceType": "StructureDefinition",
"id": "codexrt-radiotherapy-primary-plan-dose",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "cgp"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use",
"_valueCode": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://hl7.org/fhir/us/codex-radiation-therapy/ImplementationGuide/hl7.fhir.us.codex-radiation-therapy"
}
]
}
}
],
"url": "http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-primary-plan-dose",
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:oid:2.16.840.1.113883.4.642.40.14.42.25"
}
],
"version": "2.0.0",
"name": "PrimaryPlanDose",
"title": "Primary Plan Dose",
"status": "active",
"date": "2026-02-11T00:55:08+00:00",
"publisher": "HL7 International / Cross-Group Projects",
"contact": [
{
"name": "HL7 International / Cross-Group Projects",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/cgp"
},
{
"system": "email",
"value": "cgplist@lists.HL7.org"
}
]
}
],
"description": "This flag is true if the dose is the primary plan dose in a radiotherapy treatment plan.\nFor a single treatment plan, the primary plan dose serves as the main dose value for tracking delivered dose vs. planned dose.\nIn summaries over multiple treatment plans, the flag indicates that the dose is a primary plan dose in any of the summarized plans.",
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "US",
"display": "United States of America"
}
]
}
],
"fhirVersion": "4.0.1",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "complex-type",
"abstract": false,
"context": [
{
"type": "extension",
"expression": "http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-dose-planned-to-volume"
},
{
"type": "extension",
"expression": "http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-radiotherapy-dose-delivered-to-volume"
},
{
"type": "extension",
"expression": "http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-dose-prescribed-to-volume"
}
],
"type": "Extension",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
"derivation": "constraint",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "4.0.1"
}
],
"element": [
{
"id": "Extension",
"path": "Extension",
"short": "Primary Plan Dose",
"definition": "This flag is true if the dose is the primary plan dose in a radiotherapy treatment plan.\nFor a single treatment plan, the primary plan dose serves as the main dose value for tracking delivered dose vs. planned dose.\nIn summaries over multiple treatment plans, the flag indicates that the dose is a primary plan dose in any of the summarized plans.",
"min": 0,
"max": "1",
"base": {
"path": "Extension",
"min": 0,
"max": "*"
},
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false
},
{
"id": "Extension.id",
"path": "Extension.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension.extension",
"path": "Extension.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "0",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "Extension.url",
"path": "Extension.url",
"representation": [
"xmlAttr"
],
"short": "identifies the meaning of the extension",
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "uri"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"fixedUri": "http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-primary-plan-dose",
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"short": "Primary Plan Dose",
"definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list).",
"min": 0,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
]
},
"differential": {
"element": [
{
"id": "Extension",
"path": "Extension",
"short": "Primary Plan Dose",
"definition": "This flag is true if the dose is the primary plan dose in a radiotherapy treatment plan.\nFor a single treatment plan, the primary plan dose serves as the main dose value for tracking delivered dose vs. planned dose.\nIn summaries over multiple treatment plans, the flag indicates that the dose is a primary plan dose in any of the summarized plans.",
"max": "1"
},
{
"id": "Extension.extension",
"path": "Extension.extension",
"max": "0"
},
{
"id": "Extension.url",
"path": "Extension.url",
"fixedUri": "http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-primary-plan-dose"
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"short": "Primary Plan Dose",
"type": [
{
"code": "boolean"
}
]
}
]
}
}